/*
 * Copyright (C) 2012  Romain DUBOIS
 * 
 * This file is part of NeMoS - Network and Modular Software
 * 
 * NeMoS is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * NeMoS is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with NeMoS.  If not, see <http://www.gnu.org/licenses/>.
 */
package nemos.launch.progress;

/**
 * IProgressDisplay : The progress display interface.
 * 
 * <p>
 * This is a simplified interface for launch progress listening. The progress
 * compute is done by a dedicated service which regularly updates of
 * {@link IProgressDisplay} services. It also updates a displayable label.
 * </p>
 * 
 * @author Romain DUBOIS
 */
public interface IProgressDisplay {

    /**
     * Set the progress description. It is generaly the current launch step
     * name.
     * 
     * @param pLabel
     *            The progress description to set
     */
    void setLabel(String pLabel);

    /**
     * Set the new progress value. It is a value in the [0-100 interval] value
     * which always increases. A progress value of 100 means the launch is
     * ended.
     * 
     * @param pProgressValue
     *            The current progress value to set
     */
    void setProgressValue(int pProgressValue);
}
